(FormCode)

(ObjectCode)

(OCXProperties)

[1:SiteService]

[SiteService] identifies the CVS, Facility Service, or Group Service for the settings. The format for the value is Site.Service.

If this field is blank, the Site.Service specified for TheView is used. If Site.Service is defined for both TheView and the object, the value specified for the object is used.

[2:Point ID]

[2:Point ID] specifies the Point ID of the tag for which the object is to display information. The Site.Service of the point must be specified using the [1:SiteService] or [SiteService] property. Click … to view the Select a Point ID dialog box from where you can select a point to use. Script subtype is string.

[3:Long Point ID]

[3:Long Point ID] specifies the Long Point ID of the tag for which the object is to display information. The Site.Service of the point must be specified using the [1:SiteService] or [SiteService] property. Click … to view the Select a Long Point ID dialog box from where you can select a point to use. Script subtype is string.

[4:Facility ID]

[4:Facility ID] specifies the Facility ID of the point for which the object is to display information. This property must be used in conjunction with [5:UDC]. The Site.Service of the point must be specified using the [1:SiteService] or [SiteService] property. If both TheView and an object have their Facility property defined, the object’s property takes precedence. Click … to view the Select a Facility ID dialog box from where you can select a Facility ID to use. Script subtype is string.

[5:UDC]

[5:UDC] specifies the Uniform Data Code (UDC) of the point for which the object is to display information. This property must be used in conjunction with [4:Facility ID] or [Facility]. The Site.Service of the point must be specified using the [1:SiteService] or [SiteService] property. For ActiveX command tools, this property specifies the point that contains the default position for the indicator. Click … to view the Select UDC by Category dialog box from where you can select a UDC to use. Script subtype is string.

[ActiveX]

Specifies the CygNet point properties (point configuration record or CVS point record) to use to dynamically set configuration properties of the ActiveX object. See Dynamic Properties for more information.

[AlarmAckFilter]

Specifies the alarm acknowledgment filter for the Facility Alarm object. The object is displayed only if one or more alarms meet the filter criteria. If set to 1 - Unacknowledged the object is displayed only if there are unacknowledged alarms in the CAS. If set to 2 - Acknowledged the object is displayed only if there are acknowledged alarms in the CAS. The default, 0 - All, clears the filter. That is, the object is displayed regardless if alarms have been acknowledged.

[AlarmColors]

Obsolete. Replaced by [CustomStateColors].

[AlarmElement]

[AlarmElement] specifies the element of the object in which the point's alarm status is displayed. The options vary depending upon the tool. For example, with a Text Tool or the Ribbon Tool the alarm status can be shown in the foreground color (text), background color, or none. With a Linear Gauge Tool or Angular Gauge Tool the options are the pointer color or background color. If set to None, the alarm status is not shown. This property is not shown if the [StateColorMode] property is set to a value other than 1 - Single.

[AlarmStatusFilter]

Specifies the alarm status filter of the Facility Alarm object. The object is displayed only if one or more alarms meet the filter criteria. If set to 1 - Set Only, the object is displayed only when points in the CAS have an alarm bit set. The default, 0 - All, clears the filter. That is, the object is displayed regardless of if the alarms have been reset.

[AllowAlarmAck]

[AllowAlarmAck] enables display of the Acknowledge Alarm option on the Context Menu when the object’s point has an unacknowledged alarm. [DisplayAlarmAck] must also be set to true. Default is 1 - Yes.

[Application]

Specifies the CygNet application to be started when the CygNet Button Tool object is clicked. Applies only when the [ButtonType] property is set to Launch. The default is None. The other options listed are CygNet applications registered on your computer. If a Studio or Vision user has not yet loaded the application, version management will install it (provided the user has sufficient permission for the APPS).

[AutoClose]

Enables automatic closing of TheView when the CygNet Button Tool object is clicked. Applies only when the [ButtonType] property is set to HyperLink. Default is 0 - No. Set to 1 - Yes only if hyperlinking to a different screen.

[AutoRestart]

[AutoRestart] specifies whether TheView automatically restarts when a user changes a Facility Navigation Bar object, a Group Grid object, or a Group Navigation Bar object.

[AutoRestart] is typically used to reset the Facility ID of TheView for templated objects. It is not required to reset the contents in a Group Grid object.

When used with a Facility Navigation Bar or a Group Navigation Bar, the [Facility] property of TheView is set to match the facility selected in the drop-down menu.

When used with a Group Grid object, the [Facility] property of TheView changes to match the Group Grid row when the row is clicked.

Use (1 - Yes) to enable. The default is 0 - No.

[BackgroundColorMode]

Specifies the background color of the Nested View object. 0 - Default leaves the background color as it was originally defined in the nested view. 1 - Selected overrides the original color with that specified by the BackColor property.

[BlinkColor]

[BlinkColor] specifies the color that alternates with the alarm color when the [DisplayAlarmAck] property is set to 1 - Yes and the point’s alarm is unacknowledged. Default is Automatic. Be careful not to set the blink color to an alarm color or the blinking will not be visible. For example, if the blink color is red and the alarm color is red, the object will not appear to be blinking because the red blinking red will look like solid red.

[ButtonType]

Specifies the operational mode of the CygNet Button Tool object. Default is HyperLink. Other options are Standard, Execute, Launch, and View Default Trend.

• HyperLink opens the screen specified by the [FilePath] property and sets the destination screen’s [SiteService] and [Facility] to those specified by the [HyperLink Facility ID] and [HyperLink SiteService] properties. If the [HyperLink Facility ID] and [HyperLink SiteService] properties are blank it passes on the parameters of the current screen.
• Standard allows use of the EventClick (all other operational modes have an inherent Click event).
• Execute runs the application specified by the [FilePath] property and passes on the parameters specified using the [Parameters] property.
• Launch runs the CygNet application specified by the [Application] property.
• View Default Trend shows the default trend of TheView.

[Command]

Specifies the UIS Command and its parameters for the object.

[CommandPrompt]

Specifies a prompt for a command object. Default is No Prompt. Other options are Prompt for Value and Prompt for Confirmation. If prompting for a value, you can also specify the Default Value of the prompt. The Default Value can be a literal value or the current value of a point. In addition to the prompt, you can enable Show Command Confirmation Message, which indicates that the command has been successfully sent to the UIS from the DDS.

CommandFacilityId

CommandParameters

CommandSiteService

[CommentColor]

Specifies the color of the TextTool object’s comment indicator. The default is Automatic, which is the object’s foreground color.

[CommentIndicator]

Enables the TextTool object’s comment indicator, which is a flag in the top-right corner of the object that appears when the object’s point has text in the Comments field of its point configuration record. The default is 0 - No.

[ContextMenu]

[ContextMenu] specifies custom items for the object’s context menu. The Item Text is the text that appears on the Context menu. The Event ID must be unique. Each item requires script to specify its action. Click … to view the Context Menu Configuration dialog box from where you can configure the menu items. See Configuring a Context Menu.

[ContextMenuAutoSelect]

If [ContextMenuAutoSelect] is enabled, CygNet Studio will automatically select tools for the duration of context menu operations (for example, while a context menu is being displayed, and while any invoked dialog boxes that resulted from the context menu being displayed). Selection is indicated by "marching ants" around a tool in Run mode if that tool is marked as selected. This feature only applies to standard CygNet-aware tools, not special ActiveX controls such as Group Grid Tool or and Trend Tool. The default is 0 - No.

Scripting is supported using the Select and IsSelected methods for each tool. Selecting a tool via script will draw "marching ants," even if [ContextMenuAutoSelect] is disabled on TheView. Multiple tools can be selected simultaneously via script. If a tool is selected via script, and then right-clicked while [ContextMenuAutoSelect] is enabled, the tool will be automatically cleared at the completion of the context menu operation. TheView has a DeselectAll method.

Script subtype is Boolean.

[ContextMenuObjects]

[ContextMenuObjects] specifies custom items for the Context menu of all objects. The Item Text is the text that appears on the Context menu. The Event ID must be unique. Each item requires script to specify its action.

[ContextMenuView]

[ContextMenuView] specifies custom items for TheView’s context menu. The Item Text is the text that appears on the Context menu. The Event ID must be unique. Each item requires script to specify its action.

[CustomStateColors]

[CustomStateColors] specifies custom point state colors. Click … to view the Configure Point State Colors dialog box from where you can configure colors to use. See Customizing Point State Colors for more information.

• If defined for TheView, this property specifies the custom point state status colors that can be applied to all objects.
• If defined for an object, this property specifies the custom point status colors for the instance of the object. An object’s custom colors take precedence over those of TheView. If an object does not have its own custom state colors, TheView’s custom state colors will apply to the object. That is, TheView’s custom state colors serve as defaults.

[DataGroup]

Specifies the data group type and data group ordinal for which to display the editor. For templated screens, leave the SiteService and Facility ID properties blank and set the Ordinal to 9999.

[DefaultTrend]

Specifies settings of TheView’s default trend. See Default Trend for information about defining the properties of a trend and its run-time options. Script subtype is string.

[DisplayAlarmAck]

[DisplayAlarmAck] enables the display of the unacknowledged alarm state. If set to true, the object will blink when the object’s point has an unacknowledged alarm. The default is 0 - No. When this property is enabled and the condition is true, the user can acknowledge the alarm from the object’s Context Menu if the [AllowAlarmAck] property is set to 1 - Yes.

When blinking is enabled, the method in which the blink is displayed is determined by the value of the blink attribute configured in the PointSchemes element of the CvsMetadata.xml file. See Understanding the CVS Metadata File for more information.

[DisplayElement]

[DisplayElement] specifies the element of the object in which the [DisplayItem] is shown. Available options are Text and None; the default is Text.

If None is selected, the object is displayed but its [DisplayItem] is not.

Other options:

• Completely hide the object in Run mode using the Visible property.
• Display the object and its [DisplayItem] but disable user interaction using the Enable property.

[DisplayFormat]

[DisplayFormat] displays the data with custom formatting. Make sure that the format string is applicable for the [DisplayItem]. Click … to view the Display Format dialog box.

• For numbers, formats can use # and 0, with a period (.) as the decimal separator and comma (,) as the thousands separator. A dollar ($) sign can also be used. 0 will add a leading or trailing 0; # will not. For example, if the value is 8.230 and this property is set to 00.0, the result would be 08.2. If this property is set to ##.#, the result would be 8.2.
• For dates, formats can use d, h, m, s, a/p, AM/PM. For example, if the time is 06/28/2006 11:25:56.124 and the display format is hh:mm a/p, the result would be 11:25 a.
• Named formats can also be used. Examples: Long Date, Short Date, Long Time, Medium Time. If using the named formats Yes/No, True/False, On/Off, any non-zero value is Yes, True, On.
• Two specially named formats, FeetInchesFromFeet and FeetInchesFromInches, convert decimal values to feet and inches format. For example, 12.55 would be displayed as 12'6" and 150.0 would be 12'6" respectively.

[DisplayItem]

[DisplayItem] specifies the type of data the object is to display. Options include Text, properties of the point configuration record (Description, Units, UDC, etc.), properties of the CVS point record (Value, Timestamp, etc.), and facility attributes (Facility Description, Facility ID, attributes). Default setting is Value. If set to Text, the display will show the text defined using the Text property. Click … to view the Select a Display Item dialog box from where you can select what to display for the object.

[EnableHistoryPlayback]

Enables the option of the Show History Playback Bar on TheView’s context menu. Default is 0 - No. Script subtype is Boolean.

[Facilities]

Specifies which facilities must have an alarm to trigger the display of the Facility Alarm Tool object.

[Facility]

The relevant facility here. This facility is typically that of the dynagraph-enabled remote device from which you want to collect dynagraph data. Script subtype is string.

[FilePath]

Specifies path information for the CygNet Button Tool object when the object’s [ButtonType] property is set to HyperLink or Execute.

HyperLink - specifies the path (including the name of the file) that will be opened when the button is clicked. If [FilePath] points to the current screen, TheView will be restarted and the parameters specified by the [HyperLink Facility ID] and [HyperLink SiteService] properties will be passed on. (If these properties are blank, the settings of the current screen will be passed on.)

Execute - specifies the path (including the name of the executable) of the application to open when the button is clicked.

• If [FilePath] points to a file extension of .exe, the application will be opened.
• If [FilePath] points to a specific file of a known file type, the file will be opened using its application. For example, if the path points to Notepad.exe, Notepad will be opened.
• If [FilePath] points to Procedure.txt, the file will be opened using Notepad.

Script subtype is string.

[HyperLink Facility ID]

Specifies the Facility ID to be passed to the destination screen; that is, the screen defined by the [FilePath] property. Applies only when the [ButtonType] property is set to HyperLink. If blank, the current Facility ID of TheView will be passed on.

[HyperLink SiteService]

Specifies the current value service (in the format Site.Service) to be passed to the destination screen; that is, the screen defined by the [FilePath] property. Applies only when the [ButtonType] property is set to HyperLink. If blank, the current Site.Service of TheView will be passed on.

[Image]

Specifies the image to be displayed by the object. Applicable to Comment objects and Facility Alarm Tool objects.

[Images]

Specifies the image(s) to be displayed by the object. Applies to Image Tool objects and Vector Tool objects. An object can be configured to show a default image or different images based on alarm state or point state. See Working with Image Objects for more information.

[MinPriorityCategory]

Specifies the alarm priority filter for the Facility Alarm object. The object is displayed only if one or more alarms are in the specified categories. Default is None, which clears the filter. Other options are LOW, MEDIUM, HIGH, and CRITICAL. For example, if this property is set to HIGH, at least one set alarm must be in the High alarm category for the object to be displayed.

[NavBar]

Specifies the ID of the Group Navigation Bar object that will set the facilities in the Group Grid object.

[NewViewGroup]

Specifies if the hyperlinked screen is to be opened in a new view group (1 - Yes) or the current view group (0 - No). Applies only to a CygNet Button Tool object when the object’s [ButtonType] is set to Hyperlink. Default is 0 - No.

Only one instance of a screen may be opened at a time in a view group. To have multiple instances of the same screen open, each instance must be in a new view group. For example, if you want two instances of a "detail" screen open at the same time, each showing data from a different facility, the screen must be opened in a new view group.

[Parameters]

Specifies the parameters for a CygNet Button Tool object when the button’s type is Execute.

[PointList]

Specifies the properties to list in TheView’s Point List. Options include properties of the point configuration record (Description, Units, UDC, etc.), properties of the CVS point record (Value, Timestamp, etc.), and facility attributes (Facility Description, Facility ID, attributes). Default setting is tag;value. Script subtype is string.

[PositionLabel]

Specifies if the position labels of the multi-state object are the enumeration table’s entries or the entries’ descriptions. Default is Description.

[PositionOrder]

Specifies if the position labels of the multi-state object are ordered alphabetically by the enumeration table’s entries or the entries’ descriptions. Default is Description.

[PositionValue]

Specifies if the position values of the multi-state object are the enumeration table’s entries or the entries’ descriptions. Default is Entry.

[RangeHigh]

Specifies the high end of the Ribbon object’s range for purposes of scaling the fill.

[RangeLow]

Specifies the low end of the Ribbon object’s range for purposes of scaling the fill.

[ReceiveCustomEvents]

Enables automatic forwarding of Custom Events to the NestedView object. Default is 1 - Yes.

[ReferenceFacility]

[ReferenceFacility] specifies the Facility ID or facility tag of a referenced facility for which the object is to display information. The referenced facility can resolve from either a Source Attribute or a Facility Rule. Click … and choose either Select a Source Attribute or Specify Facility Rule Filter from the drop-down menu. See Configuring a Reference Facility for more information.

[RowLabelItem]

Specifies the information to display as the row label for the Group Grid Tool object. Default is Facility, which is the ID of the Facility. Other options are Facility Tag (SITE.SERVICE::FACILITYID), SiteService (the Site.Service of the facility), and Node Description (the description of the node from the navigation hierarchy, which is generally the facility description).

[SetPoint]

[SetPoint] specifies the properties of the SetPoint Button object, including the target point, default value, status point, and prompt, etc. Click … to view the SetPoint Properties dialog box from where you configure the button's properties.

[Show]

Specifies how the hyperlinked screen will be shown. Applies only when the CygNet Button Tool object’s [ButtonType] property is set to Hyperlink. Default is 0 - Default, which is the source (current) screen’s configured size. For example, if the source screen is maximized, the hyperlink screen will be maximized. Other options are 1 - Normal (the destination screen’s defined size), 2 - Minimized, and 3 - Maximized.

[SinglePointRollups]

Specifies the rollup types for the Single Point with Rollups trend option (a Run mode option).

[SiteService]

TheView - specifies the default current value service (in the format Site.Service) for all objects on TheView that have a primary CygNet point. That is, those objects that have the property [1: SiteService].

Facility Alarm Tool object - specifies the current value service (in the format Site.Service) for the points that will trigger display of the object.

[StateColorEvaluation]

[StateColorEvaluation] specifies whether the object’s color is based on its point state or its alarm state. Options are 0 - Point State and 1 - Alarm State or 1 - ePOINT_STATE and 2 - eALARM_CONDITION. The default is 0 - Point State or 1 - ePOINT_STATE.

[StateColorMode]

[StateColorMode] Specifies if and how the object will show the alarm point’s state color: shown in a single color (1 - Single), dual colors (2 - Dual), or not at all (0 - Off). The default is Single. Options include:

• Off (0 - eSTATECOLORMODE_OFF)
• Single Color (1 - eSTATECOLORMODE_SINGLE)
• Dual Colors (2 - eSTATECOLORMODE_DUAL)

Most tools have a Single mode. That is, they can reflect the point state color in a single element. The element is defined by an object’s [AlarmElement] property to specify if the state color will be shown in the object’s foreground or background. Objects that have [AlarmElement] options of both Foreground Color and Background Color, such as the Text Tool or a closed shape (ellipse, rectangle, polyline), can be configured using the [StateColorMode] property to show the point state color in dual mode; that is, both the Foreground and Background. For tools with a Dual mode, you must select the foreground and background colors using the [UseCustomStateColors] property. The default is 1 - eOFF. Options include:

• 1 - eOFF
• 2 - eSINGLE_FOREGROUND
• 3 - eSINGLE_BACKGROUND
• 4 - eDUAL

StatusPointEnable

[TimerInterval]

Specifies the rate (in milliseconds) of TheView’s timer. Valid range is any integer between 0 to 1000000000. An interval of 0 (default) disables the timer. Script subtype is long.

[Type]

Specifies the screen type of TheView. This is a free-form text field. This property applies to screens in a Workspace. Within a Workspace, all screens of a type are opened in the same position and with the same dimensions of where the last screen of the same type was closed. The position and dimensions are persisted with the Workspace. Script subtype is string.

[Units]

Specifies the set of engineering units for all objects on TheView. Default is 0 - Workspace, which means to use the units specified in the Workspace properties (File>Workspace>Workspace Properties). The Workspace default is Primary units. The other is 2 - Alternate.

Objects that have a Text property with a token selector can override the default units of TheView and using the Primary Value or Alternate Value token. These include Text Tool objects, UIS Command Button objects, DDS Editor Button objects, and CygNet Button Tool objects.

See PNT Engineering Units for more information.

Script subtype is long.

[UnknownTag]

[UnknownTag] specifies how the object will be displayed if the primary point does not exist in the system. Options include None and Hide. The default is None.

• If set to None, the object is displayed with an "unknown" status, and its color is set to the Unreliable color (meaning that the value is not trustworthy).
• If set to Hide, the object is not shown at all.

If the tag is simply invalid (for example, missing the UDC/PointID/LongPointID entirely), the object will be displayed and set to the Unreliable color. "Unknown" means that the tag appears to be valid and CygNet Studio tried to get data for it, but the service indicated the tag does not exist.

The [ReferenceFacility] property adds an additional twist to "unknown" status. If CygNet Studio believes that the tag is only invalid because of a failure to resolve the reference facility, it will treat the tag as "unknown" instead. Note that the above example of a missing UDC/PointID/LongPointID would still be invalid because ReferenceFacility doesn’t affect UDC/PointID/LongPointID, but if you are missing a Site.Service or Facility and have a ReferenceFacility rule that doesn’t reference external Source Attributes, it would assume that the rule simply couldn’t find a match and consider that "unknown."

[UpdateInterval]

For TheView, this property specifies the rate (in milliseconds) at which TheView requests new data from the services (that is, the rate at which TheView is refreshed). Valid range is any integer between 100 to 1000000000. The default is 1000.

For the Group Grid Tool, this property specifies the rate (in milliseconds) at which the grid requests data from the cache. Valid range is any integer from 100 to 1000000000. Default is 100.

Script subtype is long.

[UseCustomStateColors]

[UseCustomStateColors] enables the use of the [CustomStateColors].

• For TheView, this property enables use of TheView’s [CustomStateColors]. Default is 1 - Yes.
• For objects, this property enables use of the object’s [CustomStateColors]. Default is 1 - Yes.

If this property is set to 0 - No for an object and is set to 1 - Yes for TheView, the object will use the custom state colors of TheView.

[UseViewFacility]

Enables the Trend object to use the [Facility] property of TheView rather than its own. Default is 0 - No.

[UseViewSiteService]

Enables the Trend object to use the [SiteService] property of TheView rather than its own. Default is 0 - No.

[UseViewUnits]

Enables the object to use the [Units] property of TheView or the parent view (for the Nested View Tool) rather than its own units. Default is 0 - No.

[Value]

If the object is associated with a primary point, the value in Run mode of this property will reflect the value of the point.

[ValueItem]

Specifies if the object will display its primary point’s value (Value) or not (None). Default is Value.

AbsoluteDateRange

Specifies whether or not the object uses absolute or relative date properties. Absolute date properties are EarliestDate and LatestDate. Options are 0 - No and 1 - Yes. Default is 0 - No.

Script subtype is Boolean.

Accelerator

Specifies the Windows mnemonic (accelerator) key for Microsoft Common Control objects. Pressing Alt in combination with this key in Run mode sets the focus to the object. Select a key from the drop-down menu.

Alignment

Alignment sets the horizontal text alignment within the boundary of the object. Options are 0 -Left, 1 -Center, and 2 -Right. Default depends on the object.

AlignTextLeft

Specifies text alignment on the left side of the of the check box/radio button object if true (1 - Yes). Default is 0 - No.

AllowAllValues

If Allow All Values is selected, the All option appears for the level and all attribute values available in the child level are displayed. Otherwise, only attribute values filtered by a parent level are displayed.

AllowBlankValues

If Allow Blank Values is selected, the Not Specified option appears for the level and facilities can be displayed if no attribute value is specified.

AllowClose

Specifies whether the TheView can be closed. If set to No, the only way to close TheView is by closing the Studio Workspace or CygNet Studio. If set to Yes, TheView can be closed by selecting File>Close or selecting Close from the View’s menu, or via script. The AllowClose property cannot be tested in Preview mode. Default is 1 - Yes. Script subtype is Boolean.

AllowUnitsChange

Enables unit changes to be displayed in Run mode. Unit types affected are primary and alternate. Options are 0 - No and 1 - Yes. The default is 1 - Yes. If 0 - No is specified, the Use Alternate Units option is disabled in Run mode. Script subtype is Boolean.

For the Group Grid Tool, this change is a right-click option in the top, left cell.

AlternateUnits

Specifies that the object display values in alternate units instead of primary units. Alternate units must be defined in the point configuration record for the relevant point. Otherwise, alternate units cannot be displayed by the tool. Property sheet options are 0 - No and 1 - Yes. Default is 0 - No. Script subtype is Boolean.

AlternateUnitsOverride

Specifies the name of alternate units used when overriding alternate units derived from the point configuration record. They are defined on a per-series basis. This property is series indexed.

AlwaysOnTop

Sets the current CygNet Studio screen to stay on top of other CygNet Studio screens. You can set this preference during Run mode by clicking on the CygNet Studio icon in the upper left corner of the screen and selecting Always on Top. The property can also be set via script:

TheFrame.AlwaysOnTop(True)

Script subtype is Boolean.

AnchorSnaps

Specifies the anchor snap points for the object. See Using Snap Points Anchor Snaps.

Angle1

Specifies the angle of the starting point. 0 is horizontal to the right of center when the RotateAngle property is set to 0.  A positive value indicates a clockwise rotation. The end point is defined by the Angle2 property.

Angle2

Specifies the angle of the end point. The starting point is defined by the Angle1 property.

AnnotationColor

Specifies the color of text annotations drawn by the Display Information > Time Slice Values and Display Information > Series Tags modes. The date of the time slice remains black and cannot be changed. Default is black (RGB 0.0.0).

AnnotationColorFromSeries

Enables the color of text annotations in Display Information options to be derived from their corresponding series color. Options are 0 - No and 1 - Yes. Default is 0 - No. When set to 0 - No, the text color for all annotations is specified by AnnotationColor. When set to 1 - Yes, AnnotationColor is ignored and each text annotation is drawn in the color of its corresponding series.

Appearance

Appearance specifies whether the object boundary (graph, cell in the grid, view, etc.) will have a 3D effect or a flat appearance. Options are 0 - Flat or 1 - 3D. Default is 0 - Flat.

Arrowhead

Specifies which endpoints of the line have arrowheads. Default is 0 - None. Other options are 1 - Right, 2 - Left, 3 - Both.

ArrowheadHeight

Specifies the height (in pixels) of the arrowhead point. Default is 8. Valid range is any integer between 2 and 32.

AutoExtendEnabled

Enables the object to automatically retrieve and display new data according to a specified time interval. This appears to extend a trend to the right as it refreshes. Options are 0 - No and 1 - Yes. Default is 0 - No.

AutoExtendRateSec

Specifies the time interval in seconds by which the object refreshes. Default is 1.

AutoRecord

Script subtype is long.

AutoScale

Enables a y-axis to automatically scale according to the value of the data it displays. Available for backwards compatibility only. Use AutoScaleMax and AutoScaleMin instead.

Script subtype is Boolean. (True means that both AutoScaleMax and AutoScaleMin are true.)

AutoScaleMax

Specifies whether or not the y-axis upper limit automatically scales relative to the data it displays. When activated, overrides MaxY. Enabled by default, which means that scaling occurs automatically.

This property is axis indexed.

AutoScaleMin

Specifies whether or not the y-axis lower limit automatically scales relative to the data it displays. If activated, overrides MinY. Enabled by default, which means that scaling occurs automatically.

This property is axis indexed.

AutoSizeFont

AutoSizeFont specifies whether the object’s font is automatically resized:

Shrink to Fit and Expand to Fit resize the font in Edit mode so that the text fits the boundary of the object. You can use these options to resize the font without using the object’s Font property to explicitly set the font size. In Run mode, the font is dynamically resized in Run mode to accommodate the [DisplayItem] or the tokens specified by the Text property.

• Shrink to Fit - reduces the font size so the text fits in the object boundary. If the object is resized in Run mode, the font size can never exceed the size specified by the object’s Font property.
• Expand to Fit - increases the font size so the text fills the object boundary. If the object is resized in Run mode, the font size can never be less than the size specified by the object’s Font property.
• Best Fit - resizes the font to best fit the text inside the object boundary. If the object is resized in Run mode, the font is also resized. This setting is a combination of Shrink to Fit and Expand to Fit.

Proportional and Proportional Fit resize the font in Run mode based on resizing of TheView.

• Proportional - resizes the font proportionally to TheView as TheView is resized.
• Proportional Fit - resizes the font proportionally to the object as the object is resized. This option reduces the font size only when necessary to view all of the text. This is the recommended option when font resizing is required.

Available AutoSizeFont options are 1 - Shrink to Fit, 2 - Expand to Fit, 3 - Best Fit, 4 - Proportional, and 5 - Proportional Fit. The default is 0 - No (no font resizing).

AutoTicks

Enables display of tick marks on the Slider object based on the TickFrequency and TickStyle properties. Default is 0 - No.

AxisCount

Specifies the total number of configured y-axes in the object. In other words, specifies the upper bound for the XML axis index. This property is read only.

AxisID

Specifies the user-defined number (0 - 15) assigned to a y-axis. Once the axis ID number is assigned to a y-axis, the number cannot be changed. If you want to change an axis ID number, you must delete the axis and create a new one from the available axis ID numbers. This property is axis indexed. This property is read only.

AxisNumber

Specifies the y-axis number with which a specific series is associated. Options are integers that correspond with configured y-axes. This property is series indexed.

BackColor

Selects a background color for the object or grid. Note that if an object’s [AlarmElement] property is set to Background Color and a primary point is assigned to the object, the background color will change in Run mode to reflect the point status.

The default is Automatic, which is the background color of TheView for most objects.

• For the Group Grid Tool, BackColor specifies the background color for the object’s cell space. This does not affect the background color of the cells. To set the background color of the cells, enable UseCustomStateColors (Property Sheet, ActiveX page) and define the custom colors.
• For the CygNet GCM Nomination Grid, the default is white (RGB 255.255.255).
• For the SetPoint Button Tool, BackColor is a script property that specifies the background color of the value and the confirmation prompt dialog box for the SetPoint Button object. UsePrompt must be enabled for this setting to be recognized by the SetPoint Button object. Script subtype is long.
• For the Trend Tool, specifies the background color of a trend. Default is gray (RGB 240.240.240). Script subtype is long.

Bitmap

For Button Tool, DDS Editor Button, SetPoint Button, and UIS Command Button objects the Bitmap property specifies the image (.bmp or .jpg) to display on the button face. The only types of images supported for this option are bitmaps. For Radio Button and Check Button objects specify the image (.bmp or .jpg) to display in place of the standard check box or radio button when the button state is "on." The bitmap must be exactly 15x15 pixels. This property is only relevant when the BitmapOffState property is also configured. The default is None. Click … to view the Bitmap dialog box from where you can configure the image to use.

BitmapOffState

Radio Button and Check Button objects - specifies the image to display in place of the standard check box or radio button when the button state is "off." The bitmap must be exactly 15x15 pixels. This property is only relevant when the Bitmap property is also configured. Default is None.

BlinkIntervalMS

Specifies the time (in milliseconds) between blinks. Default is 500.

BorderColor

Specifies the border color for the Frame Tool object if the object’s BorderStyle property is set to an option other than 1 - 3D.

BorderDrawn

Enables the border on the object. Default is 0 - No.

BorderStyle

BorderStyle specifies the border style of the object boundary.

Most tools use one of these sets of options:

• 0 - ibsNone, 1 - ibsRaised, or 2 - ibsLowered, and the default is 0 - ibsNone

• 0 - None or 1 - Fixed Single, and the default is 0 - None

The Panel Switch Tool uses these options:

• 0 - ibsLine, 1 - ibsRaised, 2 - ibsLowered, 3 - ibsTop, and 4 - ibsNone, and the default is 0 - ibsLine.

For the Box, Frame, and Text tools, the BorderStyle property specifies the style of the object’s foreground lines. The options are:

• 0 - Normal, 1 - 3D, 2 - Sunken, 3 - Raised, and 4 - None

The default for the Box Tool is 0 - Normal. The default for the Frame Tool is 1 - 3D. The default for the Text Tool is 4 - None.

If you use 2 - Sunken or 3 - Raised and the effect is not visible, change the object’s HiliteColor.

If you use 0 - Normal, 2 - Sunken, or 3 - Raised, you can set the border width using the PenWidth property.

For TheFrame/TheView, the BorderStyle property specifies both the style of the object's border and whether the object can be resized by the user in Run mode. The default is 0 - Thin, which means the border is thin and the size is static. The other possible option is 1 - Resizing, which means the border is thicker and can be resized.

See also Appearance.

Script subtype is integer.

BorderWidth

Specifies the width (in pixels) of the Frame Tool object’s border. Default is 2. The object’s BorderStyle property must be set to an option other than 1 - 3D for this property to be active.

Bottom

Bottom specifies the distance in pixels from the top of the object to the bottom of the object. You can dynamically change this value in Edit mode if you use the mouse to enlarge or shrink the object.

Specifies the text for the Buttons column for a WatchList Tool.

ButtonShape

ButtonShape specifies the shape of the button. Default is 0 - Normal. Other options are 1 - Property Tab (Inactive) and 2 - Property Tab (Active).

CaseOrPassword

Specifies the case of the text typed into the object’s edit area. Default is 0 - None (mixed case allowed). Other options are 1 - Upper Case, 2 - Lower Case, 3 - Password (masked). With Password, an asterisk (*) is displayed in place of the actual character.

Check

Color

Specifies the background of TheView. Default is Automatic Gray (RGB 236, 233, 216). Script subtype is long.

Columns

Specifies the number of columns that are defined for the object or the XML that represents the list of displayed columns. Use the OCX Properties dialog box to select.

For a WatchList Tool, Columns specifies the identifier of each column. Items are semicolon separated.

ComboType

Specifies the type of ComboBox. Default is 2 - Droplist. Other option is 1 - Dropdown. The Dropdown type is editable by the user. Droplist is static.

Specifies whether or not a large value on the y-axis uses commas as its numeric divider. Options are 0 - No and 1 - Yes. Default is 1 - Yes.

CrosshairFontSize

Specifies the font size for the Display Information > Value at Cross Hairs option in Run mode. Options are 0 (large), 1 (medium), and 2 (small). Default is 2 (small).

CurrentTimeSource

Specifies the source of the current date and time used to define the limits of the view window.

Options are as follows:

• 0 - Client Time: Specifies that the view window is created relative to the client current time. Best practice strongly recommends ensuring that all relevant servers and clients are synchronized to the same time.
• 1 - Server Time: Specifies that the view window is created relative to the server (i.e., ARS) current time. If this setting is used but the server time is unavailable, the client time is used for as long as the server time is unavailable. Best practice strongly recommends ensuring that all relevant servers and clients are synchronized to the same time.
• 2 - Series Time: Specifies that the view window is created relative to the most recent time supplied by a series, server, or client. This means that if any series time on a trend is the most recent time of the three possible time sources, the series defines the latest extent of the view window and appears to be in the future. May be used as a way of correcting for time drift or other similar anomalous situations where series data appears to be "ahead" of the local current time.

Default is 0 - Client Time.

Script subtype is integer.

CursorPointer

For TheView, CursorPointer selects the cursor icon that appears when you mouse over objects.

For objects, CursorPointer selects the cursor icon for the instance of the object. The object’s cursor pointer takes precedence over TheView’s cursor pointer.

The default is 0 - Default. For TheView, this is an arrow. For other objects, the icon configured for TheView is used. Other options are:

• 1 - Arrow
• 2 - IBeam
• 3 - Cross
• 4 - UpArrow
• 5 - NoDrop
• 6 - Help
• 99 - HotSpot
• 100 - Timer

Script subtype is long.

CustomLabel1

Specifies the label name of the toolbar's Button 1. ToolbarLocation must be enabled for the toolbar and its buttons to be displayed. Default is 8.

CustomLabel2

Specifies the label name of the toolbar's Button 2. ToolbarLocation must be enabled for the toolbar and its buttons to be displayed. Default is 24.

CustomLabel3

Specifies the label name of the toolbar's Button 3. ToolbarLocation must be enabled for the toolbar and its buttons to be displayed. Default is 3D.

CustomScroll1

Specifies the time increment by which a trend's view window increases if Button 1 is clicked. The increment is relative to the unit type specified for the object's toolbar. Default is 1.

CustomScroll2

Specifies the time increment by which a trend's view window increases if Button 2 is clicked. The increment is relative to the unit type specified for the object's toolbar. Default is 8.

CustomScroll3

Specifies the time increment by which a trend's view window increases if Button 3 is clicked. The increment is relative to the unit type specified for the object's toolbar. Default is 24.

CustomSize1

Specifies the size of a trend's view window in units of time if Button 1 is clicked. The size is relative to the unit type specified for the object's toolbar. Default is 8.

CustomSize2

Specifies the size of a trend's view window in units of time if Button 2 is clicked. The size is relative to the unit type specified for the object's toolbar. Default is 24.

CustomSize3

Specifies the size of a trend's view window in units of time if Button 3 is clicked. The size is relative to the unit type specified for the object's toolbar. Default is 72.

CustomUnits

Specifies a time unit type that corresponds to the values specified for the Custom View Buttons fields View Size and Scroll Size. View Size and Scroll Size use the various CustomSize and CustomScroll properties. Options are 0 - Seconds, 1 - Minutes, 2 - Hours, 3 - Days, 4 - Weeks, and 5 - Years. Default is 2 - Hours.

CygNetTag

CygNetTag is a script property that returns a control's resolved point tag. It returns an empty string if the control has not yet retrieved point data (for instance, during EventInitialize) or if the control failed to retrieve point data. This property is read only.

CygNetTagConfig

CygNetTagConfig is a script property that returns a control's current point tag configuration. The current point tag configuration might not reflect the point displayed on the control if the control's point tag configuration has changed but TheView has not been restarted. This property is read only.

DataShadows

Specifies the display of a shadow or 3-D effect with certain graph items, like series lines. Options are 0 - None, 1 - 2D, and 2 - 3D. Default is 0 - None.

DataThinning

Enables a graph to automatically filter out excessive data points. This can improve performance if you are displaying a large amount of data. Typically, the effect of data thinning is not noticeable to a user. However, if MarkDataPoints is enabled, the effect of data thinning might be noticeable. All data points still display upon zoom. Data thinning is currently incompatible with square wave lines.

Options are as follows:

• 0 - Off: Always displays all data points.
• 1 - Basic: Enables quick data thinning, for best performance.
• 2 - Advanced: Enables slow data thinning, which is more thorough than Basic, but performance is not as good.

Default is 1 - Basic.

DecimalBase

Enables the Spinner object to use base 10 (decimal). Otherwise it uses base 16 (hexadecimal). Default is 0 - Yes (decimal values).

Default

Default enables the button as the active button when the Enter key is pressed. In Edit mode the button with this property set to true (1 - Yes) is shown with a black border. Only enabled one button as the default. Default is 0 - No.

DefaultFacilityId

Specifies a default facility ID for the object. Default is blank.

DefaultSiteService

Specifies the default current value service for the object. Default is blank.

DefaultValue

DefaultValue is a script property that returns the properties of the default value for the resolved target point to be modified by a SetPoint operation. The default value for the target point can be specified explicitly, retrieved from the current value of another point, or retrieved from a point attribute of another point. The default value can also be limited to a particular point data type. Note that the SetPoint operation will fail if the value being sent doesn’t resolve to the correct point data type.

• See Configuring Default Value for more information about configuring this value.
• See Scripting SetPoint Properties for information about using this property in script.

DisplayFont

DisplayFont returns the current, resized font values for the object. The correct font size is returned only if AutoSizeFont is enabled. For tools other than Text Tool, DDS Editor Button, SetPoint Button, and UIS Command Button DisplayFont is identical to the Font property, except that this is a font interface object instead of a string.

This property is read only.

DisplayID

Default is None.

DisplayInformation

Enables you to select one of several special display modes. Most of the following modes affect what happens when a data point on a trend is clicked. Options are 0 - None, 1 - Crosshairs, 2 - Tag, 3 - Timeslice, 4 - Timeslice Table, and 5 - Notes. Default is 0 - None.

EarliestDate

Specifies the earliest date for the control. If the date range is relative the date is calculated based on the current date/time. Format is MM/DD/YYYY hh:mm:ss AM/PM. The default is the current system date and time.

EarliestDate

Specifies the earliest (i.e., least recent) date and time for a trend for an absolute date and time view window. Format is MM/DD/YYYY hh:mm:ss AM/PM. Default is the system date and time at which the tool was first added to a screen.

If AbsoluteDateRange is not enabled, earliest date and time is calculated based on a combination of current system date and time, EarliestDateCount, and EarliestDateUnits.

EarliestDateCount

If the view window date range is relative (that is, not absolute), specifies the number of time units before the current system date and time from which to display trend data. Default is 8.

EarliestDateUnits

If the view window date range is relative (that is, not absolute), specifies the time unit type for the earliest date and time from which to display trend data. Options are 0 - Seconds, 1 - Minutes, 2 - Hours, 3 - Days, 4 - Weeks, and 5 - Years. Default is 2 - Hours.

EarliestDisplayedDate

Returns the earliest date and time displayed on a trend.

EditBuddy

Enables the Spinner to serve as an editor for the value in an EditBox object. The buddy control (that is, the Spinner) must directly follow the EditBox in the tab order. Default is 0 - No.

Enable

Enable specifies whether the user is able to interact with the object. Options are 0 - No and 1 - Yes. The default is 1 - Yes. If set to 0 - No, the object is still visible but its context menu is disabled.

Other options:

• Completely hide the object in run mode using the Visible property.
• Display the object but hide its [DisplayItem] using the [DisplayElement] property.

Currently disabled for Trend Tool.

EnableTemplateChange

Script subtype is Boolean.

EnhancedGraphics

Enables enhanced trend graphics, including anti-aliased lines and softer colors. Using this option might decrease the object's performance. Options are 0 - No and 1 - Yes. Default is 1 - Yes.

ExtendLastValue

Places a virtual data point at the current time that reflects the most recently retrieved value. This has the appearance of extending the most recently retrieved (i.e., last) value up to the current time. Can be used in combination with AutoExtendEnabled. Options are 0 - No and 1 - Yes. Default is 1 - Yes.

FacilityId

Currently disabled for Trend Tool.

FacNavBarAttributesDescriptions

Specifies the user descriptions of Facility Navigation Bar attributes.

FacNavBarAttributesValues

Specifies the values of Facility Navigation Bar attributes.

FillColor

Specifies the color to be used for a trend fill. Used in conjunction with FillEnabled. Default is green (RGB 134.223.53).

FillEnabled

Enables a solid-color fill area to be drawn between two series on the same y-axis. Options are 0 - No and 1 - Yes. Default is 0 - No.

FillSeries1

Specifies one of the two series used to delimit a trend fill on the same y-axis. When enabled by FillEnabled, the area between this series and that specified by FillSeries2 is a solid color.

Option is a non-negative integer that correlates to the delimiting series's configured series index number. The configured series index number is the number given to a series in the vertical order it appears in the series hierarchy of a Trend Tool. The topmost series is 0, the next series down is 1, and so on. Default is -1. This property is series indexed.

FillSeries2

Specifies one of the two series used to delimit a trend fill on the same y-axis. When enabled by FillEnabled, the area between this series and that specified by FillSeries1 is a solid color.

Option is a non-negative integer that correlates to the delimiting series's configured series index number. The configured series index number is the number given to a series in the vertical order it appears in the series hierarchy of a Trend Tool. The topmost series is 0, the next series down is 1, and so on. Default is -1. This property is series indexed.

FixedFonts

Prevents fonts from increasing in size as the object is resized. Options are 0 - No and 1 - Yes. Default is 1 - Yes.

FixedLineWidth

If enabled, prevents series line type widths from increasing in size as the object is resized. If disabled, only a subset of available series line types resize as the object resizes. The subset is as follows:

• Medium Solid
• Thick Solid
• Medium Thin Solid
• Medium Thick Solid
• Extra Thick Solid

This property maintains legacy behavior for existing screens. Options are 0 - No and 1 - Yes. Default is 1 - Yes.

FixedRatio

Specifies the resizing behavior of TheFrame. Set to 1 - Yes to force proportional resizing. Default is 0 - No. Script subtype is long.

FlexHorizontal

FlexHorizontal specifies whether the object moves or resizes horizontally or is unchanged when TheFrame is resized. Options are:

• 0 - None (no resizing occurs)
• 1 - Shift (the object is shifted)
• 2 - Expand (the object expands or shrinks the same number of pixels as TheFrame)
• 3 - Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 - None.

FlexVertical

FlexVertical specifies whether the object moves or resizes vertically when TheFrame is resized. Options are:

• 0 - None (no resizing occurs)
• 1 - Shift (the object is shifted)
• 2 - Expand (the object expands or shrinks the same number of pixels as TheFrame)
• 3 - Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 - None.

Font

Font specifies the font for the object.

For TheView, this property specifies the default font for text-based objects.

For other objects, it specifies the font for the instance of the object. The object’s font takes precedence over the font set for TheView.

Click … to view the Font dialog box, which you can use to configure the font. The default is MS Shell Dlg (MS Sans Serif, regular, 8 pt). Script subtype is string.

Currently disabled for Trend Tool.

FontSize

Specifies the size of textual items on the object relative to the size of the object. Options are 0 - Large, 1 - Medium, and 2 - Small. Default is 1 - Medium.

ForeColor

ForeColor specifies the foreground color for the object. The default is Automatic, which, for most objects is black. Note that if the object’s [AlarmElement] is set to Foreground Color and a primary point has been assigned to the object, the foreground color will change in Run mode to reflect the point status.

ForeColor

Specifies the foreground color of textual items outside the object's graph. Default is black (RGB 0.0.0).

GraphBackColor

Specifies the background color of the object's graph. Default is white (RGB 245.245.245).

GraphBorderStyle

Specifies the use of a border and border style for an object's graph.

Options are as follows:

• 0 - None
• 1 - Thin Line
• 2 - Thick Line
• 3 - Shadow
• 4 - 3D Inset

Default is 1 - Thin Line.

GraphForeColor

Specifies the foreground color of the object's graph. Default is dark gray (RGB 128.128.128).

GraphShadowColor

Specifies the color of the object's graph shadow. Default is dark gray (RGB 128.128.128). GraphBorderStyle must be set to Shadow in order for GraphShadowColor to take effect.

GridBands

Displays the graph with a banded-background view for improved visibility. The GraphBackColor property changes the band colors. Options are 0 - No and 1 - Yes. Default is 1 - Yes.

GridInFront

Specifies whether or not to have grid lines appear in front of series lines or behind series lines. Options are 0 - No and 1 - Yes. Default is 0 - No.

GridLines

Specifies whether or not grid lines are displayed on the object's graph. Options are 0 - Both, 1 - Y Axis, 2 - X Axis, and 3 - None. Default is 0 - Both.

GridStyle

Specifies the style of grid lines displayed on the object's graph. Options are 0 - Thin Lines, 1 - Thick Lines, 2 - Dotted Lines, and 3 - Dashed Lines. Default is 2 - Dotted Lines.

Group

Group groups objects into a discrete sequence that can be navigated using the arrow keys.

Options are 0 - No and 1 - Yes. The default is 0 - No.

To use this property:

1. Add objects that use the Group property to a screen.

2. Position them as you like (typically in a spatial configuration that reflects the order in which they were added to the screen).

3. Decide where in the spatial configuration logical groups begin and end.

4. Mark the beginning of a group by setting the Group property to 1 - Yes for the first object in the group.

5. Set Group set to 0 - No for other objects in the group.

The group is made up of all objects that 1) are added sequentially after an object with a Group property set to 1 - Yes and 2) that use a Group property set to 0 - No. A group's arrow navigation sequence reflects the order in which its objects were added to a screen.

This property is not related to the Draw > Group option in the CygNet Studio menu bar. This property might not be suited for use with all tools that include the Group property.

Script subtype is long.

GroupCount

Specifies the number of groups on the screen. Script subtype is long.

GroupID

Specifies the GroupID of the object group.

HasValidTag

Returns a Boolean value to confirm that a CygNet-aware tool is associated with a valid CygNet tag. This property may not be suited for use with all tools that include the HasValidTag property. See also CygNet-Aware Tools. Script subtype is Boolean.

HatchStyle

Specifies the fill hatch style for the object. This property can be applied only to closed objects. Default is 0 - None. Other options are 1 -Horizontal, 2 -Vertical, 3 -Diagonal, 4 - Reverse Diagonal, 5 -Cross, 6 -Diagonal Cross.

Height

Specifies the height of TheFrame (in pixels). This property is displayed only when TheFrame is not maximized. Script subtype is long.

HelpContextID

HelpContextID specifies the object’s help identifier for context-sensitive help. TheFrame’s WhatsThisHelp must be enabled.

Script subtype is long.

HelpHotButton

Enables display of the object’s help button, which is a question mark. When a user clicks this button in Run mode, a help topic is displayed corresponding to the HelpContextID. Default is 0 - No.

HiliteColor

Text Tool and Box Tool - specifies the color used for highlights if the object’s BorderStyle is set to 2 - Sunken or 3 - Raised. Default is Automatic. Any color can be selected.

Hilite Tool - specifies the highlight color. Default is 1 - Yellow. Other options are 2 - Magenta and 3 - Cyan.

HistoryPlaybackTime

Script subtype is variant.

HorizontalScroll

Enables display of a horizontal scroll bar. Default is 0 - None. Other option is 1 - Always if scroll bar is necessary. The MultiEdit Box tool includes a third option: 2 - Automatic.

IncrAccelerator

Specifies the amount by which the Spinner object increments the value in its associated Edit Box object. Default is 1.

InitialFilter

Initial Filter defines a subset of facilities. If you are defining multiple levels, the Initial Filter is level 0, the leftmost drop-down level in the Facility Navigation Bar Tool. Additional filtering will begin with the level 0 filter.

InitialFilterRules

Specifies the facility Initial Rule filter.

IsAxisEmpty

Returns a Boolean value to confirm whether or not a y-axis has no series assigned to it. True indicates that a y-axis has no series assigned to it. If true, the y-axis is not displayed in Run mode. This property is axis indexed. This property is read only.

IsCygNetAware

Returns a Boolean value that confirms that an object is a CygNet-aware tool. This property might not be suited for use with all tools that include the IsCygNetAware property. Script subtype is Boolean. See also CygNet-Aware Tools.

IsWedge

Specifies if the Arc object’s end points are connected to the center. The properties Angle1 and Angle2 define the starting and end point positions.

LabelAttribute

Specifies the label attribute for a specified level as an integer.

• When this property is set, two parameters are required: an integer that specifies the level for the label attribute and a second integer that identifies the label attribute (for example, FacNavBar.X.LabelAttribute 0, 30).
• When this property is retrieved, one parameter is required: an integer that specifies the level for the label attribute being retrieved (for example, MsgBox FacNavBar.X.LabelAttribute(0)).

LabelAttributeString

Specifies the label attribute of a specified level as a string.

• When this property is set, two parameters are required: an integer that specifies the level for the label attribute, and a string that identifies the label attribute (for example, FacNavBar.X.LabelAttributeString 0, "facility_category").
• When this property is retrieved, one parameter is required: an integer that specifies the level for the label attribute being retrieved (for example, MsgBox FacNavBar.X.LabelAttributeString(0)).

LabelFont

Specifies the trend label font type. It does not apply to title and sub-title font. Default is Arial.

LabelFontBold

Specifies whether or not label font is bold. Options are 0 - No and 1 - Yes. Default is 0 - No.

LabelFontItalic

Specifies whether or not label font is italic. Options are 0 - No and 1 - Yes. Default is 0 - No.

LabelFontUnderline

Specifies whether or not label font is underlined. Options are 0 - No and 1 - Yes. Default is 0 - No.

LabelText

Specifies the label text for a specified level.

• When this property is set, two parameters are required: an integer that specifies the level for the label text and a string that is the label text (for example, FacNavBar.X.LabelText 0, "Facility Category").
• When this property is retrieved, one parameter is required: an integer that specifies the level for the label text being retrieved (for example, MsgBox FacNavBar.X.LabelText(0)).

LabelType

Specifies the label type for a specified level. The property can be 1 - Attribute or 2 - Text.

• When this property is set, two parameters are required: an integer that specifies the level for the label and an integer that specifies the label type (for example, FacNavBar.X.LabelType 0, 1).
• When this property is retrieved, one parameter is required: an integer that specifies the level for the label type (for example, MsgBox FacNavBar.X.LabelType(0)).

LatestDate

Specifies the latest or most recent date for the control. Format is MM/DD/YYYY hh:mm:ss AM/PM. The default is current system date and time.

LatestDate

Specifies the latest (i.e., most recent) date and time for a trend for an absolute date and time view window. Format is MM/DD/YYYY hh:mm:ss AM/PM. Default is the system date and time at which the tool was first added to a screen.

If AbsoluteDateRange is not enabled, earliest date and time is calculated based on a combination of current system date and time, EarliestDateCount, and EarliestDateUnits.

LatestDisplayedDate

Returns the latest date and time displayed on a trend.

Layer

Layer identifies the layer on which the object resides. Script subtype is Boolean.

LayerId is a script property that specifies the layer on which the object resides. Options vary depending on the names of existing layers. Default is Default.

Layout

Layout specifies the position of the image within the object’s boundaries. Default is 0 - Center. Other options are 1 - Left, 2 - Right, 3 - Top, and 4 - Bottom.

Left

Left specifies the distance (in pixels) from the left edge of TheView’s scroll region to the left edge of the object.

LeftFromScreen

Script subtype is long.

Legend

Returns and displays the legend string appropriate to that defined by token substitution.

LegendFormat

Specifies various number-based legend formatting options. Exposed for legacy support. Default is 0.

LegendFormatStr

Specifies the tokenized legend format. Default is %longdescription%.

LegendLocation

Specifies the location of the legend relative to the graph. Options are 0 - None, 1 - Top, 2 - Bottom, 3 - Left, and 4 - Right. Default is 2 - Bottom.

LegendOutline

Specifies whether or not to have a legend item's series icon outlined. Options are 0 - No and 1 - Yes. Default is 0 - No.

LegendOverride

Specifies a legend format that overrides the one specified by LegendFormatStr on a per-series basis. You can specify a tokenized legend format or user-defined text. This property is series indexed.

LineType

Specifies the line appearance and/or size for a single series line.

Options are as follows:

• 0 - Thin Solid
• 1- Dashed
• 2 - Dotted
• 3 - Dash Dot
• 4 - Dash Dot Dot
• 5 - Medium Solid
• 6 - Thick Solid
• 7 - Medium Thin Solid
• 8 - Medium Thick Solid
• 9 - Extra Thick Solid
• 10 - Extra Thin Solid
• 11 - Extra-Extra Thin Solid

Default is 0 - Thin Solid. This property is series indexed.

ListID

Default is None.

ListItems

Specifies the list choices for the Radio Button object or ComboBox object. Items are identified by Name and Value. Either identifier can be used in script. By default, no items are present.

MarkDataPoints

Specifies whether or not to have solid black dots drawn at data points. This property is not related to PointType. Options are 0 - No and 1 - Yes. Default is 0 - No.

MaximizeBox

Enables or disables display of TheFrame’s maximize box in the title bar. Default is 1 - Yes. Script subtype is long.

MaximumEq

Specifies the upper value limit (maximum equation) of Spinner and Slider objects. The value must be a constant.

MaximumHeight

Specifies the maximum height (in pixels) to which TheFrame can be resized. Default is 0. Script subtype is long.

MaximumPointSize

Specifies the setting of an upper limit for the size of data points. This ensures that points do not scale to an unreasonably large size. Only works if MarkDataPoints is set to 1 - Yes.

Options are as follows:

• 0 - None: Places no upper boundary on the size of a data point. Data points continue to increase in size as a trend tool is expanded.
• 1 - Small: Ensures that data points scale within a range appropriate to a small point. Scales to a maximum size of 2 pixels.
• 2 - Medium: Ensures that data points scale within a range appropriate to a medium point. Scales to a maximum size of 6 pixels.
• 3 - Large: Ensures that data points scale within a range appropriate to a large point. Scales to a maximum size of 10 pixels.

Default is 3 - Large.

MaximumWidth

Specifies the maximum width (in pixels) to which TheFrame can be resized. Default is 0. Script subtype is long.

MaxY

Specifies the user-defined upper limit a y-axis displays. The y-axis scale adjusts accordingly. Overridden if AutoScaleMax is enabled. This property is axis indexed.

MinimizeBox

Enables or disables display of TheFrame’s minimize box in the title bar. Default is 1 - Yes. Script subtype is long.

MinimumEq

Specifies the lower value limit (minimum equation) of Spinner and Slider objects. The value must be a constant.

MinimumHeight

Specifies the minimum height (in pixels) to which TheFrame can be resized. Default is 0. Script subtype is long.

MinimumWidth

Specifies the minimum width (in pixels) to which TheFrame can be resized. Default is 0. Script subtype is long.

MinY

Specifies the user-defined lower limit a y-axis displays. The y-axis scale adjusts accordingly. Overridden if AutoScaleMin is enabled. This property is axis indexed.

MonoAnnotationColor

Specifies the grayscale color of text annotations drawn by the Display Information > Time Slice Values and Display Information > Series Tags modes. Useful with black and white or grayscale printers. The date of the time slice remains black and cannot be changed. Default is black (RGB 0.0.0).

MonoBackColor

Specifies the grayscale color of the trend's background. Useful with black and white or grayscale printers. Default is white (RGB 255.255.255).

MonoForeColor

Specifies the grayscale color of the trend's foreground. Useful with black and white or grayscale printers. Default is black (RGB 0.0.0).

MonoGraphBackColor

Specifies the grayscale color of the graph's background. Useful with black and white or grayscale printers. Default is white (RGB 255.255.255).

MonoGraphForeColor

Specifies the grayscale color of the graph's foreground. Useful with black and white or grayscale printers. Default is gray (RGB 128.128.128).

MonoGraphShadowColor

Specifies the grayscale color of the graph's shadow. Useful with black and white or grayscale printers. Default is gray (RGB 128.128.128).

NoteFilter

Specifies a filter by which to sort and display notes on trend. On the Property Sheet, you can manually enter a filter. You can also use the Set Note Rules dialog box to do so. Default is blank.

Notification

Specifies the pop-up box notification message for a WatchList Tool. Use the OCX Properties dialog box to define.

NumDropped

Specifies the number of choices dropped when the user opens the ComboBox object.

NumericPrecision

Specifies the number of decimal places to display for the Display Information > Value at Cross Hairs option in Run mode. Default is 3.

ObjectCount

Script subtype is long.

OnRightAxis

Specifies the position of a y-axis label relative to the graph. If set to false, position is to the left of a y-axis. This property is axis indexed.

OptimizedDraw

Enables the highest screen painting rate. Default is 1 - Yes. Only set to 0 - No if objects are not painted correctly when the screen is initialized or refreshed in Run mode. Script subtype is Boolean.

Orientation

Specifies the orientation of the Spinner object or Slider object. Default is 0 - Horizontal. Other option is 1 - Vertical. If you change the orientation you must manually resize its boundary to match.

OverlayYAxis

Specifies whether or not a y-axis belongs to the same axis group as the y-axis previous to it. This property is axis indexed.

OverrideAlternateUnits

Enables a user to override the alternate units derived from the point configuration record on a per-series basis. This property is series indexed.

OverridePrimaryUnits

Enables a user to override the primary units derived from the point configuration record on a per-series basis. This property is series indexed.

OwnerDrawn

Enables the CheckBox object to display an item other than the customary checkmark. Specifically, it enables the CheckBox object to display a bitmap. Images for both the Bitmap and BitmapOffState properties must be specified for the owner-drawn to be applicable. Default is 1 - Yes.

The CheckBox object’s TriState property requires that the object is not owner-drawn. To have the CheckBox object show three states, set this property to 0 - No.

PenStyle

Specifies the style of the object’s line or border. Default is 0 - Solid. Other options are 1 -Dash, 2 -Dot, 3 -Dash-Dot, and 4-Dash-Dot-Dash. All options except 0 - Solid have a pen width of 1.

PenWidth

Specifies the size (in pixels) of an object’s line or border. Default is 1. With the Text Tool, this property only appears if the BorderStyle property style is set to an option other than None.

PlotSquareWave

Specifies whether or not a series displays in a square wave. MarkDataPoints must be enabled for PlotSquareWave to take effect. This property is series indexed.

PlotStyle

Specifies the appearance of series on a per-y-axis basis. Default is 0 - Line. This property is axis indexed.

Options are as follows:

• 0 - Line
• 1 - Bar
• 2 - Points
• 3 - Area
• 4 - Points + Best Fit Curve
• 5 - Points + Best Fit Line
• 6 - Points + Line
• 7 - Points + Spline
• 8 - Spline

Using points plot styles (for instance, Points + Line) in conjunction with PlotSquareWave or ExtendLastValue might result in inauthentic points for the purposes of enabling those options. Conversely, using points plot styles in conjunction with DataThinning might result in fewer displayed data points.

PointId

[2:Point ID] specifies the Point ID of the tag for which the object is to display information. The Site.Service of the point must be specified using the [1:SiteService] or [SiteService] property. Click … to view the Select a Point ID dialog box from where you can select a point to use. Script subtype is string.

PointId

Specifies the point ID of the tag for which a series is to display information. This property is series indexed.

PointIdLong

Specifies the long point ID of the tag for which a series is to display information. This property is series indexed.

PointTag

PointTag is a script property that returns a PointTag object. The object can be used to parse a constituent part from a resolved point tag for a given CygNet-aware tool. For instance, the PointTag object would enable you to parse LongPointId from the tag Site.Service.PointId:LongPointId. Note that the resolved tag might differ from the configured tag.

The PointTag property is similar in functionality to the CygNetTag property; however, the CygNetTag property returns an entire point tag.

This property is read only.

PointType

Specifies the shape of a data point icon for a series. The series's assigned y-axis must be set to a PlotStyle that includes points (for instance, Points, Points + Best Fit Curve, Points + Best Fit Line, Points + Line, or Points + Spline). This property is series indexed.

Options are as follows:

• 0 - Plus
• 1 - Cross
• 2 - Circle
• 3 - Solid Circle
• 4 - Square
• 5 - Solid Square
• 6 - Diamond
• 7 - Solid Diamond
• 8 - Upward Triangle
• 9 - Solid Up Triangle
• 10 - Downward Triangle
• 11 - Solid Down Triangle

Default is 3 - Solid Circle.

PrimaryUnitsOverride

Specifies the name of primary units used when overriding primary units derived from the point configuration record. They are defined on a per-series basis. This property is series indexed. Default is 3 - Solid Circle.

PrintScale

Specifies the scale at which the screen is printed. The default , 1, equals 100%. Value must be a positive number (examples: 2 equals 200%; 0.5 equals 50%). Script subtype is double.

Prompt

Prompt is a script property that returns the properties of the value and confirmation prompt that can be optionally configured when executing a SetPoint operation.

• See Configuring a Prompt for more information about configuring this property.
• See Scripting SetPoint Properties for information about using this property in script.

PropertyXml

Lists a trend's properties in an XML format. Useful for copying XML records in or out of the tool.

ReadOnly

Disables typing in the Edit Box or MultiEdit Box object. Default is 0 - No.

RemoveSelection

Enables the List Box selection to be removed. Default is 0 - No.

ReportLock

Script subtype is long.

Right

Right specifies the distance (in pixels) from the left edge of TheView’s scroll region to the right edge of the object.

RollupPeriod

Specifies the time interval by which a rollup type takes place. This property is series indexed. See History Rollups for more information.

RollupType

Specifies the type by which to roll up data for a selected point. This property is series indexed.

Options are as follows:

• 0 - None
• 1 - Calculated Weighted Average
• 2 - Calculated Mean
• 3 - Calculated Minimum
• 4 - Calculated Maximum
• 5 - Calculated Delta
• 6 - Calculated Last
• 7 - Thin Median
• 8 - Thin Minimum/Maximum
• 9 - Thin Last

Default is 0 - None.

Using RollupType might be preferable to using DataThinning because rollup calculations performed by the VHS can provide improved performance and reduced network traffic relative to DataThinning.

See History Rollups for more information.

RollupUnits

Specifies the time units by which a rollup takes place. This property is series indexed.

Options are as follows:

• 0 - None
• 1 - Minutes
• 2 - Hours
• 3 - Days
• 4 - Seconds

Default is 0 - None.

See History Rollups for more information.

RotateAngle

Causes the object to rotate clockwise the specified number of degrees. You can rotate an object directly by using the Rotate option on the Draw menu. For details, see Rotating an Object.

Currently disabled for Trend Tool.

RuntimeCfgAutoPersist

Specifies whether run-time settings applied using script automatically persist between Facility Navigation Bar loads. Default is 0 - No.

RuntimeCfgPersistName

Specifies the registry key to be used for persisting run-time settings. The default is DefaultRuntimeCfg.

ScrollBars

Enables or disables horizontal and vertical scroll bars on TheFrame. Default is 0 - No. If enabled, scroll bars are displayed when the size of TheFrame is less than the sizes specified by the ScrollHeight and ScrollWidth properties. Options are 0 - No, 1 - Yes, and 2 - Scrollbars with Flex.

To show scroll bars on a non-resizing screen, set the property to 1 - Yes and set the ScrollHeight and ScrollWidth to values greater than the screen size. Script subtype is long.

ScrollCount

Specifies the number of time units by which to scroll forwards and backwards along a graph.

ScrollHeight

Specifies the size of TheFrame (in pixels) at which the vertical scroll bar is displayed. Default is 800. The ScollBars property must be enabled. Script subtype is long.

ScrollUnits

Specifies the time unit type by which to scroll forwards and backwards along a graph. Default is 2 - Hours.

Options are as follows:

• 0 - Seconds
• 1 - Minutes
• 2 - Hours
• 3 - Days
• 4 - Weeks
• 5 - Years

ScrollWidth

Specifies the size of TheFrame (in pixels) at which the horizontal scroll bar is displayed. Default is 650. The ScollBars property must be enabled. Script subtype is long.

Selection

Specifies the selected items in the List Box object or ComboBox object.

SelectionsPersistName

Specifies the registry key to which a run-time selection (target) is written for persistence. The default is DefaultSelections.

SeriesColor

Specifies a color for a single series. This property is series indexed.

SeriesCount

Specifies the total number of configured series in a trend. In other words, specifies the upper bound for the XML series index.

SeriesData

Lists a trend's properties in an XML format. Useful for copying XML records in or out of the tool.

SetPointTimeoutInSeconds

SetPointTimeoutInSeconds is a script property that specifies the number of seconds to wait for the target point’s current value timestamp to match the timestamp submitted, that is, for the SetPoint operation to complete before marking the operation as failed. Default value is 5 seconds. UseSetPointTimeout must be enabled (set to true) in order for this timeout setting to be recognized by the SetPoint Button object. Script subtype is Integer.

ShadowStyle

Specifies the object’s shadow position. The shadow is displayed as a gray (RGB 172,168,153), offset duplicate object. Default is 0 - None. Other options are 1 - Top/Left, 2 - Bottom/Right, 3 - Bottom/Left, 4 - Top/Right. The shadow color and length are configurable.  Shadows cannot be applied to rotated objects.

ShowConfirmationWhenSetPointCompletes

ShowConfirmationWhenSetPointCompletes is a script property used to display a message to confirm that the SetPoint operation was issued successfully to the CVS.

• You will always get a confirmation message regardless of whether a timeout is set.
• If a confirmation message is enabled and a timeout is set, a message will confirm that the SetPoint operation completed successfully. If the SetPoint operation doesn’t complete successfully, a message will display noting that the SetPoint operation timed out before completion.

Script subtype is Boolean.

ShowDescriptions

Specifies whether descriptions (rather than table entry names) are shown for table-driven facility attributes.

ShowExtra

Enables the display of the item specified by the [DisplayItem] property in the foreground of the Ribbon object. Default is 1 - Yes.

ShowLabels

Specifies whether labels appear above the drop-down menus. Default is 1 - Yes.

ShowTargetLevel

If Levels is selected, the last drop-down menu in the Facility or Group Navigation Bar contains a list of facilities or leaf nodes based on the last level. Otherwise, the last drop-down shows the last level in the hierarchy.

ShowUnreliable

Enables unreliable values to be included in series. Options are 0 - No and 1 - Yes. Default is 0 - No.

SiteService

Specifies the site and service of the tag for which a series is to display information. The format of the value is Site.Service. This property is series indexed.

Sort

Enables alphabetizing of the choices in the List Box object or ComboBox object. Default is 0 - No, which means items are shown in the order they are listed programmatically.

SpacerWidth

SpacerWidth specifies the margin between the text and the aligned border. Applicable only if the Alignment property is set to 0 - Left or to 2 - Right. Default is 5.

Status

Status is a script property that returns the properties of the status point that can be configured to monitor the status of a SetPoint operation as it completes.

• See Configuring a Status Point for more information about configuring this value.
• See Scripting SetPoint Properties for information about using this property in script.

SubTitle

Specifies the subtitle of the object. The subtitle is displayed at the top of the object, but below the title. Default is blank.

SubTitleDateRange

Enables the display of the date range specified for the graph. If enabled, the date range displays below the title and beside the subtitle (if a subtitle is specified). Options are 0 - No and 1 - Yes. Default is 1 - Yes.

SubTitleFont

Specifies the object subtitle font type. It does not apply to title and label font. Default is Arial.

SubTitleFontBold

Specifies whether or not subtitle font is bold. Options are 0 - No and 1 - Yes. Default is 0 - No.

SubTitleFontItalic

Specifies whether or not subtitle font is italic. Options are 0 - No and 1 - Yes. Default is 0 - No.

SubTitleFontUnderline

Specifies whether or not subtitle font is underlined. Options are 0 - No and 1 - Yes. Default is 0 - No.

Tabstop

Tabstop specifies whether the focus stops on the object when you use the Tab key to navigate between objects (in other words, enables the object as a tab stop). Options are 0 - No and 1 - Yes. Default is 1 - Yes.

Script subtype is long.

See also Group and Tab Order.

Tag

Tag is an extra field for application-specific purposes. Does not specify a CygNet point. Default is blank. Script subtype is string.

TargetLevel

Returns the number of the target level of the filter hierarchy.

TargetTag

TargetTag is a script property that returns the point tag properties of the resolved target point to be modified by a SetPoint Button object. The target point can be very explicitly defined allowing a templated point tag, inheriting some or all of the point identifier properties from the button properties or from a reference facility. Alternatively a fully qualified point tag may be specified. Either ResolvedPointTag or FullyQualifiedTag must be configured.

• See Configuring General Properties for more information about configuring this value.
• See Scripting SetPoint Properties for information about using this property in script.

Text

Text specifies the text (label) of the object. A maximum of 80 characters can be specified. The object’s [DisplayItem] property must be set to Text in order for the text specified in this property to be displayed. If the object has a primary point and its [DisplayItem] property is set to a value other than Text, then in Run mode the text defined by this property will be replaced by the [DisplayItem].

For some objects and buttons (Button, DDS Editor Button, LED Switch, Sliding Scale, Text, and UIS Command Button Tools), the text can be dynamic, static, or a combination. Dynamic text is built using tokens, which can represent point configuration, facility, and CVS point record properties. Data formatting can be specified. See Using Text Tokens for more information about building dynamic text using tokens.

TextOverflow

Specifies the behavior of text if the text is too wide to fit as a single horizontal line in the tool. The default is 1 - WordWrap, which will wrap the text to another line. Other options are 0 - Truncate (cuts off the text), 2 - Ellipsis (adds an ellipsis to the end of the string), and 3 - Replace with # (fills the single line with pound signs).

TickFrequency

Specifies the interval between tick marks for the Slider object when the Slider’s AutoTicks property is set to true (1 - Yes). The Slider object range will be divided into this number of equally sized areas. For example, a frequency of 10 would result in 10 equal areas and 11 tick marks. Default is 10. Valid range is 2 to 100.

TickStyle

Specifies which side of the Slider object to place the tick marks. Default is 0 - Both. Other options are 1 - Top/Left and 2 - Bottom/Right. The Top and Bottom settings apply when the object’s orientation is horizontal. The Left and Right settings apply when the object’s orientation is vertical.

Title

Specifies the text displayed in title bar of TheFrame and on the Window menu. This is a free-form text field. Script subtype is string.

Title

Specifies the title of the trend. The title is displayed at the top of the trend. Default is blank.

TitleFont

Specifies the trend title font type. It does not apply to subtitle and label font. Default is Arial.

TitleFontBold

Specifies whether or not title font is bold. Options are 0 - No and 1 - Yes. Default is 0 - No.

TitleFontItalic

Specifies whether or not title font is italic. Options are 0 - No and 1 - Yes. Default is 0 - No.

TitleFontUnderline

Specifies whether or not title font is underlined. Options are 0 - No and 1 - Yes. Default is 0 - No.

ToolbarLocation

Specifies the location of the toolbar relative to the graph. Options are 0 - None, 1 - Top, and 2 - Bottom. Default is 0 - None.

ToolTipText

TooltipText identifies text that is displayed when the mouse hovers over the object in Run mode. For some objects, tooltip text can be dynamic, static, or a combination. You build dynamic text with tokens that can represent point configuration, facility, and CVS point record properties. You can also specify data formatting. Click … to view the Edit Tooltip Text dialog box you use to configure the text.

For information about building dynamic text using tokens, see Using Text Tokens.

Script subtype is string.

ToolType

Returns a CygNet-defined string value that describes the object type. This value appears in the Status Bar when you hover over a default control in its tool palette. You can also display the value using a script. This property is read only. See also Rule-Based Substitution.

Script subtype is string.

Top

Top specifies the distance (in pixels) from the top of TheView’s scroll region to the Top of the object.

TopFromScreen

Script subtype is long.

TopOfSubUnit

TopOfSubUnit specifies the interval by which a rollup takes place by an additional unit of magnitude smaller than that specified by RollupUnits. Subunit means whatever unit of time is the next smaller than that specified for RollupUnits. This property is series indexed.

TransparentColor

Specifies the color value in the loaded image to be rendered as transparent (same as the background color).

TrendFileName

Specifies the file name for the object and is present for backwards compatibility. Default is blank.

TriState

Enables the CheckBox object to have three states (true, false, indeterminate). Default is 0 - No.

Udc

Specifies the UDC of the tag for which a series is to display information. This property is series indexed.

UpdateIntervalSec

Specifies the time (in milliseconds) the WatchList object requests data from the cache.

UseAlarmColor

Specifies the use of CygNet point state colors for a single series. Only takes effect if a trend is displaying one series.

Options are 0 - No and 1 - Yes. Default is 0 - No.

UseColors

Enables the BackColor and ForeColor properties of Combo Box, List Box, Edit Box, and MultiEdit Box objects. Default is 0 - No. Must be set to 1 - Yes to specify custom colors.

UseSetPointTimeout

UseSetPointTimeout is a script property that indicates whether to use a timeout when attempting to set a value for the SetPoint operation. SetPointTimeoutInSeconds must be configured. Script subtype is Boolean.

UseTabStops

Enables tabs in the List Box strings to be displayed. That is, use the tabs to align the text in columns. The string must contain embedded tabs (for example, "Jane" & vbTab & "Doe"). Default is 0 - No.

Value

Used in script to specify different values in different objects:

• Arrow LED — value of the associated point
• Check Button — value of the checked state
• Combo Box — value of the drop-down item
• Diamond LED — value of the associated point
• Radio Button — value of the mutually exclusive item
• Ribbon Tool — value of the associated point
• Round LED — value of the associated point
• Slider — value of the tick

ValueID

Specifies the ID number of the value for the following objects (in configuration and in script):

• Check Button — the checked state
• Combo Box — the drop-down item
• Edit Box —
• List Box — the list item
• MultiEdit Box —
• Radio Button — the mutually exclusive item
• Slider — the tick
• Spinner Tool — constants on the spinner

The default is None.

VerticalAlignment

Vertically aligns the text within the object’s boundaries. Default is 1 - Center.

VerticalScroll

Enables display of a vertical scroll bar. Default is 0 - None. Other option is 1 - Always if scroll bar is necessary. The MultiEdit Box tool includes a third option: 2 - Automatic.

VhsOverride

Specifies the name of a VHS used to override a series's default VHS. Can only be used on a series-by-series basis. Default is blank. This property is series indexed.

ViewGroupID

Script subtype is long.

ViewID

Script subtype is long.

ViewLayers

Opens the Layers Sheet box. See Using Layers.

ViewSizeCount

If the view window date range is relative (that is, not absolute), specifies the size (in number of time units) of the view window. Default is 8.

ViewSizeUnits

If the view window date range is relative (that is, not absolute), specifies the time unit type for the view window. Options are 0 - Seconds, 1 - Minutes, 2 - Hours, 3 - Days, 4 - Weeks, and 5 - Years. Default is 2 - Hours.

ViewStyle

Specifies whether or not the object displays in color or grayscale. Options are 0 - Color, 1 - Monochrome, and 2 - Monochrome + Symbols. Default is 0 - Color.

Visible

Visible secifies whether the object is visible in Run mode. Options are 0 - No or 1 - Yes. Default is 1 - Yes.

You can also:

• Display the object but hide its [DisplayItem] using the [DisplayElement] property.
• Show both the object and its [DisplayItem] but disable user interaction using the Enable property.
• Hide the object if the point does not exist using the [UnknownTag].

Visible

Specifies whether or not an object in a trend is displayed in Run mode.

Options are 0 - No and 1 - Yes. Default is 1 - Yes.

WantKeyInput

Enables the List Box object to accept keyboard input. Default is 1 - Yes.

WhatsThisHelp

Enables context-sensitive help for TheFrame, TheView, and its objects. Default is 0 - No. Script subtype is long.

Width

Specifies the height of TheFrame (in pixels). This property is displayed only when TheFrame is not maximized. Script subtype is long.

WidthType

Specifies the width type of a specified level. Options are 1 - Variable or 2 - Fixed.

• When this property is set, two parameters are required: an integer that specifies the level for the width type and an integer that identifies the width type (for example, FacNavBar.X.WidthType 0, 1).
• When this property is retrieved, one parameter is required: an integer that specifies the level for the width type being retrieved (for example, MsgBox FacNavBar.X.WidthType(0)).

WrapAround

Enables the Spinner object to increment from the maximum to minimum value and vice-versa. Default is 1 - Yes.

XAxisLabel

Specifies the x-axis label for the object. Default is blank.

YAxisLabel

Specifies a user-defined y-axis label. It is specified on an axis-by-axis basis. Default is blank. This property is axis indexed.

YAxisLabelColorFromSeries

Specifies whether or not the color of the y-axis label and the y-axis scale are determined by SeriesColor. Alternatively, you can specify the y-axis color using ForeColor. YAxisLabelColorFromSeries is overridden by UseAlarmColor, if UseAlarmColor is enabled. Options are 0 - No and 1 - Yes. Default is 0 - No. This property is axis indexed.

YAxisLabelFromLegend

Specifies whether or not a y-axis label derives from its respective series legend. If not, can be user defined or blank. Options are 0 - No and 1 - Yes. Default is 0 - No.

YAxisType

Specifies the scale type of a y-axis.

Options are as follows:

• 0 - Automatic: If the data range is larger than or equal to 10e3 and all values are greater than zero, then a log scale is used. Otherwise, a linear scale is used.
• 1 - Linear: A linear scale is used.
• 2 - Logarithmic: A logarithmic scale is used if all values are greater than zero. Otherwise, a linear scale is used.

Default is 1 - Linear.

ZoomOverview

Specifies whether or not to display a zoom overview window below the graph whenever the graph is in zoom mode. This property performs optimally when enabled in conjunction with EnhancedGraphics. Options are 0 - No and 1 - Yes. Default is 1 - Yes.